home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / programm.ing / ams__l~1.zoo / man / sound.man < prev    next >
Encoding:
Text File  |  1993-09-05  |  2.6 KB  |  83 lines
  1.                         ATARI MACHINE SPECIFIC LIBRARY
  2.  
  3.  
  4.  
  5. NAME
  6.      Sound
  7.  
  8. SYNOPSIS
  9.      #include <Sound.h>
  10.  
  11.      void Sound(short Channel, short Pitch, short Volume)
  12.      void SetEnvelope(short WaveForm, short Period)
  13.      void SetNoisePeriod(short P)
  14.      void SoundOff()
  15.      void SetPitch(short Channel, short Pitch)
  16.      void SetVolume(short Channel, short Volume)
  17.      void SetNoisy(short Channel, bool Noisy)
  18.      void SetActive(short Channel, bool Active)
  19.      void SoundControl(short Active, short Noisy)
  20.  
  21. DESCRIPTION
  22.      There are three ways in which an application may produce sound:
  23.         1) Dosound      - Sound changes every vertical retrace
  24.            2) Giaccess     - Sound changed by the calls
  25.         3) Sample sound - Sound changes at high frequency
  26.  
  27.      These methods are basicaaly incompatible with each other.
  28.      This module provides low-level support (2), through a set of
  29.      functions.  A higher level interface is provided by SoundEnvelope,
  30.      which overcomes the limitations of the sound chip's envelope feature.
  31.  
  32. CONSTANTS
  33.      USE_ENVELOPE
  34.        When used as the volume, the associated channel uses the
  35.        current envelope for volume control.
  36.  
  37. FUNCTIONS
  38.      In the following, 
  39.          Channel = 0..2
  40.          Pitch   = 0..4095      0=High pitch, 4095=Low pitch
  41.          Volume  = 0..15, 16.   0=Silent, 15=Load, 16=Envelope driven
  42.  
  43.      void Sound(short Channel, short Pitch, short Volume)
  44.        Play sound at the given Pitch and Volume on the given Channel.
  45.  
  46.      void SetEnvelope(short WaveForm, short Period)
  47.        Set the envelope shared by all channels with Volume=16.
  48.  
  49.      void SetNoisePeriod(short P)
  50.        Set the noise randomness shared by all channels with Noisy enabled.
  51.  
  52.      void SoundOff()
  53.        Turn off all sound.
  54.  
  55.      void SetPitch(short Channel, short Pitch)
  56.      void SetVolume(short Channel, short Volume)
  57.      void SetNoisy(short Channel, bool Noisy)
  58.      void SetActive(short Channel, bool Active)
  59.        Individual controls.
  60.  
  61.      void SoundControl(short Active, short Noisy)
  62.        Set the given BITWISE channels active/noisy.
  63.  
  64. USAGE
  65.  
  66. SEE ALSO
  67.      SoundEnvelope, SampledSound, Dosound (in osbind.h)
  68.  
  69. AUTHOR
  70.      Warwick Allison, 1992.
  71.      warwick@cs.uq.oz.au
  72.  
  73. COPYING
  74.      This functionality is part of the Atari Machine Specific Library,
  75.      and is Copyright 1992 by Warwick W. Allison.
  76.  
  77.      The Atari Machine Specific Library is free and protected under the
  78.      GNU Library General Public License.
  79.  
  80.      You are free to copy and modify these sources, provided you acknowledge
  81.      the origin by retaining this notice, and adhere to the conditions
  82.      described in the GNU LGPL.
  83.